﻿


namespace Petra.Gis.RenderingServices.PlanarBase 
{
  /// <summary>
  /// Definition of linear units.
  /// </summary>
  public class MapPaperUnit
  {

    /// <summary>
    /// represents an instance of a Map Paper Unit unit
    /// </summary>
    /// <param name="metersPerUnit">Number of meters per defined unit</param>
    /// <param name="name">Name</param>
    /// <param name="remarks">remarks name</param>
    public MapPaperUnit(double metersPerUnit, string name, string remarks)
    {
      _MetersPerUnit = metersPerUnit;
      _name = name;
      _remarks = remarks;
    }

    #region DistanceUnit Members

    private double _MetersPerUnit;

    /// <summary>
    /// Gets or sets the number of meters per <see cref="LinearUnit"/>.
    /// </summary>
    public double MetersPerUnit
    {
      get { return _MetersPerUnit; }
      set { _MetersPerUnit = value; }
    }


    private string _name;


    public string Name 
    {
      get { return _name; }
    }





    private string _remarks;

    public string Remarks
    {
      get { return _remarks; }
    }




    #endregion

    ///// <summary>
    ///// Checks whether the values of this instance is equal to the values of another instance.
    ///// Only parameters used for coordinate system are used for comparison.
    ///// Name, abbreviation, authority, alias and remarks are ignored in the comparison.
    ///// </summary>
    ///// <param name="obj"></param>
    ///// <returns>True if equal</returns>
    //public override bool EqualParams(object obj)
    //{
    //  if (!(obj is DistanceUnit))
    //    return false;
    //  return (obj as DistanceUnit).MetersPerUnit == this.MetersPerUnit;
    //}
  }
}